/*
 * Copyright 2008 the Breachwalls OSS project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.breachwalls.mogen.xml.context;

import java.util.List;

import com.breachwalls.mogen.model.Model;
import com.breachwalls.mogen.xml.bean.GenerateModels;

/**
 * 自動生成ファイルを読み込んだモデルの情報を保存しておくためのコンテキスト.
 * @author todoken
 * @version $Revision: 31 $
 */
public interface ModelParseContext {

    /**
     * 自動生成するモデルのXML定義をコンテキストに登録する.
     * @param models 自動生成するモデルのXML定義
     */
    void register(GenerateModels models);

    /**
     * コンテキストに保存されている全てのモデル定義を取得する.
     * @return 全てのモデル定義
     */
    List<Model> getAllModels();

    /**
     * モデル名をもとにそのモデル定義を取得する.
     * @param name 取得したいモデルの名称
     * @return 該当するモデル定義
     */
    Model findByName(String name);

    /**
     * コンテキストをコンパイルする.
     */
    void compile();

}
